/**
 *
 * The MIT License
 *
 * Copyright (c) 2008 Board of Trustees, Leland Stanford Jr. University. All rights reserved.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:

 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.

 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
package org.macdadi.ks.client;

import com.google.gwt.user.client.ui.AbstractImagePrototype;
import com.google.gwt.user.client.ui.Composite;
import com.google.gwt.user.client.ui.ImageBundle;

/**
 * A 'view' is a single panel of the MACDADI application. They are meant to be lazily
 * instantiated so that the application doesn't pay for all of them on startup.
 */
public abstract class View extends Composite
{
    protected ViewContainer container;

    /**
     * An image provider to make available images to Views.
     */
    // TODO: if we want to customize a tree, implement TreeImages here
    public interface Images extends ImageBundle
    {
        AbstractImagePrototype logo();
    }

    /**
     * Encapsulated information about a view. Each view is expected to have a
     * static <code>init()</code> method that will be called by the main app
     * on startup.
     */
    public abstract static class ViewInfo
    {
        private View instance;
        private String name, description;

        public ViewInfo(String name, String description)
        {
            this.name = name;
            this.description = description;
        }

        public abstract View createInstance(ViewContainer container);

        public String getColor()
        {
            return "#2a8ebf";
        }

        public String getDescription()
        {
            return description;
        }

        public final View getInstance(ViewContainer container)
        {
            if (instance != null) {
                return instance;
            }
            return (instance = createInstance(container));
        }

        public String getName()
        {
            return name;
        }
    }

    /**
     * Called just before this view is hidden.
     */
    public void onHide()
    {
    }

    /**
     * Called just after this view is shown.
     */
    public void onShow()
    {
    }
}
